home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / internet-tools / connect-line / cl / devkit / docs / cl_mui.doc < prev    next >
Encoding:
Text File  |  1995-09-01  |  13.5 KB  |  663 lines
  1. TABLE OF CONTENTS
  2.  
  3. cl_mui.library/--macro-instances--
  4. cl_mui.library/CLMUI_Boards2lv
  5. cl_mui.library/CLMUI_CheckmarkExcludeA
  6. cl_mui.library/CLMUI_Copy_lv_Active
  7. cl_mui.library/CLMUI_DisableA
  8. cl_mui.library/CLMUI_ErrorRequest
  9. cl_mui.library/CLMUI_FindDel
  10. cl_mui.library/CLMUI_FindIn_lv
  11. cl_mui.library/CLMUI_Gruppen2lv
  12. cl_mui.library/CLMUI_HelpFileName
  13. cl_mui.library/CLMUI_Info
  14. cl_mui.library/CLMUI_Links2lv
  15. cl_mui.library/CLMUI_lv2Gruppen
  16. cl_mui.library/CLMUI_lv2Verteiler
  17. cl_mui.library/CLMUI_NewObjectA
  18. cl_mui.library/CLMUI_SetCycleChain
  19. cl_mui.library/CLMUI_str2lv
  20. cl_mui.library/CLMUI_TickDelay
  21. cl_mui.library/CLMUI_Verteiler2lv
  22. cl_mui.library/CLMUI_WildcardSelect
  23. cl_mui.library/--macro-instances--         cl_mui.library/--macro-instances--
  24.  
  25.                        
  26.    FUNCTION
  27.  
  28.    cl_mui.library (V3) contains several function instances of
  29.    actual MUI macros which should help to reduce code size.
  30.    You can get redefinitions of the standard macros by adding
  31.  
  32.    #define _CLMUI_MACROFUNCS
  33.    #include <cl/cl_mui.h>
  34.  
  35.    before including any mui headers.
  36.  
  37.    Macros include:
  38.  
  39.       String()
  40.       KeyString()
  41.       CheckMark()
  42.       KeyCheckMark()
  43.       SimpleButton()
  44.       KeyButton()
  45.       Cycle()
  46.       KeyCycle()
  47.       Radio()
  48.       KeyRadio()
  49.       Slider()
  50.       KeySlider()
  51.       PopButton()
  52.       xLabelx()
  53.  
  54.  
  55. cl_mui.library/CLMUI_Boards2lv                 cl_mui.library/CLMUI_Boards2lv
  56.  
  57.    NAME
  58.    CLMUI_Boards2lv -- load Connectline board-list into the given MUI
  59.                       listview-gadget.
  60.  
  61.    SYNOPSIS
  62.    CLMUI_Boards2lv( lv, Autoeintrag )
  63.                    A0        D1
  64.  
  65.    void CLMUI_Boards2lv( APTR, BOOL );
  66.  
  67.    FUNCTION
  68.    Load  Connectline board-list into given listview
  69.  
  70.    INPUTS
  71.    lv -- MUI listview-object
  72.    Autoeintrag -- TRUE if only boards with "Autoeintrag von ..." should 
  73.                   be displayed
  74.  
  75.    EXAMPLE
  76.  
  77.    NOTES
  78.  
  79.    BUGS
  80.    None known.
  81.  
  82.    SEE ALSO
  83.  
  84. cl_mui.library/CLMUI_CheckmarkExcludeA cl_mui.library/CLMUI_CheckmarkExcludeA
  85.  
  86.    NAME
  87.    CLMUI_CheckmarkExcludeA -- Creates Checkmarks which exclude themselves
  88.  
  89.    SYNOPSIS
  90.    CLMUI_CheckmarkExcludeA( checkmark, ... )
  91.                    A0        D1
  92.  
  93.    void CLMUI_CheckmarkExcludeA( APTR, ... );
  94.  
  95.    FUNCTION
  96.    Sets Methods in a way, that only one of the given checkmarks can be
  97.    checked at the same time. If one gets check, every other one gets
  98.    unselected
  99.  
  100.    INPUTS
  101.    checkmark -- MUI checkmark-object
  102.  
  103.    EXAMPLE
  104.  
  105.    NOTES
  106.  
  107.    BUGS
  108.    None known.
  109.  
  110.    SEE ALSO
  111.  
  112. cl_mui.library/CLMUI_Copy_lv_Active       cl_mui.library/CLMUI_Copy_lv_Active
  113.  
  114.    NAME
  115.    CLMUI_FindIn_lv -- Copies active entry from one listview to another
  116.  
  117.  
  118.    SYNOPSIS
  119.    CLMUI_( lv_src, lv_dest )
  120.              A0      A1
  121.  
  122.    CLMUI_Copy_lv_Active( APTR, APTR );
  123.  
  124.    FUNCTION
  125.    Copies active entry of the source listview and copies it to the other one.
  126.    If it is already present there, it won't be inserted a second time.
  127.  
  128.    INPUTS
  129.    lv_src -- MUI listview-gadget source
  130.    lv_dest -- MUI listview-gedget destination
  131.  
  132.    EXAMPLE
  133.  
  134.    NOTES
  135.  
  136.    BUGS
  137.    None known.
  138.  
  139.    SEE ALSO
  140.  
  141. cl_mui.library/CLMUI_DisableA                   cl_mui.library/CLMUI_DisableA
  142.  
  143.    NAME
  144.    CLMUI_DisableA -- Enable/Disable List Of Objects (V10)
  145.                        
  146.    SYNOPSIS
  147.    CLMUI_DisableA( state, objlist )
  148.                     D0      A0
  149.                         
  150.    void CLMUI_DisableA( LONG, APTR * );
  151.    void CLMUI_Disable( LONG, ..., NULL );
  152.  
  153.  
  154.    FUNCTION
  155.    Sets MUIA_Disabled, state on all objects.
  156.  
  157.    INPUTS
  158.    state -- TRUE or FALSE
  159.    objlist -- NULL terminated list of objects
  160.  
  161.    RESULT
  162.    None.
  163.  
  164.    EXAMPLE
  165.  
  166.    NOTES
  167.  
  168.    BUGS
  169.    Will crash if objlist contains more than 128 objects.
  170.  
  171.    SEE ALSO
  172.  
  173. cl_mui.library/CLMUI_ErrorRequest           cl_mui.library/CLMUI_ErrorRequest
  174.  
  175.    NAME
  176.    CLMUI_ErrorRequest -- check error and display requester.
  177.                        
  178.    SYNOPSIS
  179.    errorcode = CLMUI_ErrorRequest()
  180.    D0                      
  181.  
  182.    LONG CLMUI_ErrorRequest( void );
  183.  
  184.    FUNCTION
  185.    Perform MUI_Error() and, upon a non-null return, display
  186.    an appropriate error requester.
  187.  
  188.    INPUTS
  189.    None.
  190.  
  191.    RESULT
  192.    errorcode -- as returned from MUI_Error(). The requester
  193.                 is only displayed if the return value is
  194.                 none-null.
  195.  
  196.    EXAMPLE
  197.  
  198.    NOTES
  199.  
  200.    BUGS
  201.    None known.
  202.  
  203.    SEE ALSO
  204.  
  205. cl_mui.library/CLMUI_FindDel                     cl_mui.library/CLMUI_FindDel
  206.  
  207.    NAME
  208.    CLMUI_FindDel -- Deletes an entry of a listview given by its name
  209.  
  210.    SYNOPSIS
  211.    CLMUI_FindDel( lv, searchstring )
  212.                    A0      A1
  213.  
  214.    CLMUI_FindIn_lv( APTR, char * );
  215.  
  216.    FUNCTION
  217.    Delete an entry of a listview given by its name
  218.  
  219.    INPUTS
  220.    lv -- MUI listview-gadget
  221.    searchstring -- name of entry to delete
  222.  
  223.    EXAMPLE
  224.  
  225.    NOTES
  226.  
  227.    BUGS
  228.    None known.
  229.  
  230.    SEE ALSO
  231.  
  232. cl_mui.library/CLMUI_FindIn_lv                 cl_mui.library/CLMUI_FindIn_lv
  233.  
  234.    NAME
  235.    CLMUI_FindIn_lv -- Looks for an entry in a listview of strings and
  236.                       returns ist position.
  237.  
  238.  
  239.    SYNOPSIS
  240.    position = CLMUI_FindInlv( lv, searchstring )
  241.                    A0      A1
  242.  
  243.    long CLMUI_FindIn_lv( APTR, char * );
  244.  
  245.    FUNCTION
  246.    Find entry in Listview and return its position
  247.  
  248.    INPUTS
  249.    lv -- MUI listview-gadget
  250.    searchstring -- String to search for
  251.  
  252.    EXAMPLE
  253.  
  254.    NOTES
  255.  
  256.    BUGS
  257.    None known.
  258.  
  259.    SEE ALSO
  260.  
  261. cl_mui.library/CLMUI_Gruppen2lv               cl_mui.library/CLMUI_Gruppen2lv
  262.  
  263.    NAME
  264.    CLMUI_Gruppen2lv -- Display COnnectline group flag-set in a MUI 
  265.                        listview-gadget
  266.  
  267.  
  268.    SYNOPSIS
  269.    CLMUI_Gruppen2lv( groups, lv )
  270.                      A0      A1
  271.  
  272.    void CLMUI_Gruppen2lv( char *, APTR );
  273.  
  274.    FUNCTION
  275.    Displays all group-names an selects flags set.
  276.  
  277.    INPUTS
  278.    groups -- flag-set for groups
  279.    lv -- MUI listview-gadget
  280.  
  281.    EXAMPLE
  282.  
  283.    NOTES
  284.  
  285.    BUGS
  286.    None known.
  287.  
  288.    SEE ALSO
  289.    lv2Gruppen()
  290.  
  291. cl_mui.library/CLMUI_HelpFileName           cl_mui.library/CLMUI_HelpFileName
  292.  
  293.    NAME
  294.    CLMUI_HelpFileName -- return name of application help file (V8)
  295.                        
  296.    SYNOPSIS
  297.    CLMUI_HelpFileNameA( appname, to )
  298.                           A0     A1
  299.                          
  300.    void CLMUI_HelpFileName( STRPTR, STRPTR );
  301.  
  302.    FUNCTION
  303.    Returns the complete path name of the application help file.
  304.    Correctly handles locale et al settings.
  305.  
  306.    INPUTS
  307.    appname -- name of your application
  308.    to -- where to write the name to. Must be at least 128 chars.
  309.  
  310.    RESULT
  311.    None.
  312.  
  313.    EXAMPLE
  314.  
  315.     UBYTE helpfile[ 128 ];
  316.     CLMUI_HelpFileName( "CL-Port-Prefs", helpfile );
  317.  
  318.     ApplicationObject,
  319.         MUIA_Application_HelpFile, helpfile,
  320.  
  321.    NOTES
  322.  
  323.    BUGS
  324.    None known.
  325.  
  326.    SEE ALSO
  327.  
  328. cl_mui.library/CLMUI_Info                           cl_mui.library/CLMUI_Info
  329.  
  330.    NAME
  331.    CLMUI_Info -- display Info requester (v4)
  332.  
  333.    SYNOPSIS
  334.    CLMUI_Info( applicationobject )
  335.                       A0         
  336.  
  337.    void CLMUI_Info( APTR );
  338.  
  339.    FUNCTION
  340.    Display standard Connectline MUI-Info requester.
  341.  
  342.    INPUTS
  343.    applicationobject -- pointer to a MUI application object.
  344.                         This will serve as a source of information
  345.                         for the information text to display.
  346.  
  347.    RESULT
  348.    None.
  349.  
  350.    EXAMPLE
  351.  
  352.    NOTES
  353.  
  354.    BUGS
  355.    None known.
  356.  
  357.    SEE ALSO
  358.  
  359. cl_mui.library/CLMUI_Links2lv                   cl_mui.library/CLMUI_Links2lv
  360.  
  361.    NAME
  362.    CLMUI_Links2lv -- load Connectline system-list into the given MUI
  363.                       listview-gadget.
  364.  
  365.    SYNOPSIS
  366.    CLMUI_Links2lv( lv )
  367.                     A0
  368.  
  369.    void CLMUI_Boards2lv( APTR );
  370.  
  371.    FUNCTION
  372.    Load Connectline system-list into given listview
  373.  
  374.    INPUTS
  375.    lv -- MUI listview-object
  376.  
  377.    EXAMPLE
  378.  
  379.    NOTES
  380.  
  381.    BUGS
  382.    None known.
  383.  
  384.    SEE ALSO
  385.  
  386. cl_mui.library/CLMUI_lv2Gruppen               cl_mui.library/CLMUI_lv2Gruppen
  387.  
  388.    NAME
  389.    CLMUI_lv2Gruppen -- Copy contents of am MUI Listview to a group-set
  390.  
  391.  
  392.    SYNOPSIS
  393.    CLMUI_lv2Gruppen( lv, groups, mode)
  394.                      A0    A1     D0
  395.  
  396.    void CLMUI_Boards2lv( APTR, char *, ULONG );
  397.  
  398.    FUNCTION
  399.    Copies listviews contents to a flag set.
  400.  
  401.    INPUTS
  402.    lv -- MUI listview-object
  403.    groups -- flag-set to be written to
  404.    mode -- One of the following:
  405.  
  406.        CLMUI_MODE_OVERWRITE: All flags will be cleared an every entry selecte
  407. d
  408.                              in the listview will be set.
  409.        CLMUI_MODE_ADD:       Selected entries will be set in the flag-set
  410.        CLMUI_MODE_DEL:       Selected entries will be cleared in the flag-set
  411.  
  412.  
  413.    EXAMPLE
  414.  
  415.    NOTES
  416.  
  417.    BUGS
  418.    None known.
  419.  
  420.    SEE ALSO
  421.    CLMUI_Gruppen2lv()
  422.  
  423. cl_mui.library/CLMUI_lv2Verteiler           cl_mui.library/CLMUI_lv2Verteiler
  424.  
  425.    NAME
  426.    CLMUI_lv2Verteiler -- Copy contents of am MUI Listview to an entry
  427.                          in the board-list as a "Verteiler"
  428.  
  429.    SYNOPSIS
  430.    CLMUI_lv2Verteiler( lv, board, mode)
  431.                        A0   A1     D0
  432.  
  433.    void CLMUI_Verteiler2lv( APTR, struct Brett *, ULONG );
  434.  
  435.    FUNCTION
  436.    Copies listviews contents to a board as a "Verteiler"
  437.  
  438.    INPUTS
  439.    lv -- MUI listview-object
  440.    board -- valid entry in the board list, to be written to
  441.    mode -- One of the following:
  442.  
  443.        CLMUI_MODE_OVERWRITE: All entries will be cleared an every entry
  444.                              in the listview will be copied.
  445.        CLMUI_MODE_ADD:       All entries will be added.
  446.        CLMUI_MODE_DEL:       All entries will be deleted.
  447.  
  448.  
  449.    EXAMPLE
  450.  
  451.    NOTES
  452.  
  453.    BUGS
  454.    None known.
  455.  
  456.    SEE ALSO
  457.    CLMUI_Verteiler2lv()
  458.  
  459. cl_mui.library/CLMUI_NewObjectA               cl_mui.library/CLMUI_NewObjectA
  460.  
  461.    NAME
  462.    CLMUI_NewObjectA -- find Connectline specific MUI class and
  463.                        perform a new object on it (V1)
  464.    CLMUI_NewObject -- varargs version
  465.  
  466.    SYNOPSIS
  467.    object = CLMUI_NewObjectA( classname, taglist )
  468.    D0                         A0         A1
  469.  
  470.    APTR CLMUI_NewObjectA( STRPTR, APTR );
  471.    APTR CLMUI_NewObject( STRPTR, ... );
  472.  
  473.    FUNCTION
  474.    Finds a Connectline specific MUI class and performs a
  475.    NewObject on it with the given tag parameters. 
  476.  
  477.    INPUTS
  478.    classname -- name of class you wish to create an instance of.
  479.    taglist -- passed down to NewObject().
  480.  
  481.    RESULT
  482.    object -- Pointer to your newly created class instance or NULL
  483.              upon error.
  484.  
  485.    EXAMPLE
  486.  
  487.    NOTES
  488.    You must *not* close "cl_mui.library" before disposing
  489.    all objects created with CLMUI_NewObject(), otherweise
  490.    the class libraries might get expunged while in use...
  491.  
  492.    BUGS
  493.    None known.
  494.  
  495.    SEE ALSO
  496.  
  497. cl_mui.library/CLMUI_SetCycleChain         cl_mui.library/CLMUI_SetCycleChain
  498.  
  499.    NAME
  500.    CLMUI_SetCycleChainA -- set cycle chain of window object (V7)
  501.    CLMUI_SetCycleChain -- varargs version (V7)
  502.                        
  503.    SYNOPSIS
  504.    CLMUI_SetCycleChainA( windowobj, objects )
  505.                             A0         A1
  506.    CLMUI_SetCycleChain( windowobj, obj1, ... )
  507.                          
  508.    void CLMUI_SetCycleChainA( APTR, APTR * );
  509.    void CLMUI_SetCycleChain( APTR, ... );
  510.  
  511.    FUNCTION
  512.    Performs DoMethodA( windowobj, MUIM_Window_SetCycleChain, objects ),
  513.    but handles object list differently: NULL items are skipped
  514.    silently and the list is ended with CLMUI_SCCEND (-1). This allows
  515.    for dynamically build cycle chains.
  516.  
  517.    INPUTS
  518.    windowobj -- MUI window object
  519.    objects -- List of objects (not TagItems!)
  520.  
  521.    RESULT
  522.    None.
  523.  
  524.    EXAMPLE
  525.  
  526.        CLMUI_SetCycleChain( mainwin,
  527.           gadget1,
  528.           gadget2,
  529.           gadget3,
  530.           gadget4
  531.           CLMUI_SCCEND
  532.       );
  533.  
  534.    NOTES
  535.  
  536.    BUGS
  537.    None known.
  538.  
  539.    SEE ALSO
  540.  
  541. cl_mui.library/CLMUI_str2lv                       cl_mui.library/CLMUI_str2lv
  542.  
  543.    NAME
  544.    CLMUI_str2lv -- Copies a string into a listview
  545.  
  546.  
  547.    SYNOPSIS
  548.    CLMUI_str2lv( lv, string )
  549.            A0    A1
  550.  
  551.    CLMUI_str2lv( APTR, char * );
  552.  
  553.    FUNCTION
  554.    Copies the string into the listview.
  555.    If it is already present there, it won't be inserted a second time.
  556.  
  557.    INPUTS
  558.    lv -- MUI listview-gadget
  559.    str -- String to copy
  560.  
  561.    EXAMPLE
  562.  
  563.    NOTES
  564.  
  565.    BUGS
  566.    None known.
  567.  
  568.    SEE ALSO
  569.  
  570. cl_mui.library/CLMUI_TickDelay                 cl_mui.library/CLMUI_TickDelay
  571.  
  572.    NAME
  573.    CLMUI_TickDelay -- Delay() with MUIM_InputBuffered (V9)
  574.                        
  575.    SYNOPSIS
  576.    CLMUI_TickDelay( appobj, ticks )
  577.                       A0      D0
  578.                         
  579.    void CLMUI_TickDelay( APTR, LONG );
  580.  
  581.    FUNCTION
  582.    Same as dos.library/Delay(), but constantly does
  583.    MUIM_Application_InputBuffered every ~10 ticks.
  584.    Correctly measures delay due to the input handler
  585.    and bases it's timing on this.
  586.  
  587.    INPUTS
  588.    appobj -- your application object
  589.    ticks -- number of ticks to delay
  590.  
  591.    RESULT
  592.    None.
  593.  
  594.    EXAMPLE
  595.  
  596.    NOTES
  597.  
  598.    BUGS
  599.    None known.
  600.  
  601.    SEE ALSO
  602.  
  603. cl_mui.library/CLMUI_Verteiler2lv           cl_mui.library/CLMUI_Verteiler2lv
  604.  
  605.    NAME
  606.    CLMUI_Verteiler2lv -- Display Connectline board "Verteiler" in a MUI
  607.                        listview-gadget.
  608.  
  609.  
  610.    SYNOPSIS
  611.    CLMUI_Verteiler2lv( board, lv )
  612.                      A0      A1
  613.  
  614.    void CLMUI_Verteiler2lv( struct Brett *, APTR );
  615.  
  616.    FUNCTION
  617.    Adds all entries in the "Verteiler" to the listview.
  618.  
  619.    INPUTS
  620.    board -- board to read from
  621.    lv -- MUI listview-gadget
  622.  
  623.    EXAMPLE
  624.  
  625.    NOTES
  626.  
  627.    BUGS
  628.    None known.
  629.  
  630.    SEE ALSO
  631.    lv2Verteiler()
  632.  
  633. cl_mui.library/CLMUI_WildcardSelect       cl_mui.library/CLMUI_WildcardSelect
  634.  
  635.    NAME
  636.    CLMUI_WildcardsSelect -- Selects entries in a multiselect-listview
  637.  
  638.  
  639.    SYNOPSIS
  640.    CLMUI_WildcardSelect( lv, wildcard, state )
  641.                          A0      A1      D0
  642.  
  643.    CLMUI_str2lv( APTR, char *, LONG);
  644.  
  645.    FUNCTION
  646.    Sets those entries in the listview, which match the wildcard, to
  647.    the given state (TRUE or FALSE);
  648.  
  649.    INPUTS
  650.    lv -- MUI multiselect listview-gadget
  651.    wildcard -- wildcard pattern
  652.    state -- state to set matching entries to
  653.  
  654.    EXAMPLE
  655.  
  656.    NOTES
  657.  
  658.    BUGS
  659.    None known.
  660.  
  661.    SEE ALSO
  662.  
  663.